home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfpcbdr.zip / SFPCBDR.DOC next >
Text File  |  1991-08-13  |  13KB  |  260 lines
  1.                                   SFPCBDR
  2.                 PC Board Door To SPITFIRE Conversion Program     
  3.                                Version 1.2
  4.                            Written By Mike Woltz
  5.                            Buffalo Creek Software    
  6.  
  7.  
  8.     INTRODUCTION
  9.     ------------  
  10.      
  11.        SFPCBDR is a utility written by Mike Woltz, author of SPITFIRE, to
  12.     enable PC Board door programs (Version 12.x and Version 14.x) to be 
  13.     used with SPITFIRE.  Using SFPCBDR you may setup the PC Board door 
  14.     program to be used either as a SPITFIRE door or as a Sysop configurable 
  15.     command from the SPITFIRE Main, Message or File menus.
  16.    
  17.    
  18.     HOW IT WORKS 
  19.     ------------
  20.     
  21.        SFPCBDR.EXE must exist in the main SPITFIRE system files directory.
  22.     This is absolutely necessary for SFPCBDR to access other files which
  23.     are required for the proper execution of SFPCBDR.
  24.            
  25.        The files required to run PC Board Version 12.x door programs and
  26.     those required to run PC Board Version 14.x are very different, even
  27.     though the file names are the same.  To distinguish whether the door
  28.     being converted to SPITFIRE is PC Board Version 12.x or Version 14.x
  29.     SFPCBDR.EXE uses command line parameters.  If you are running a PC
  30.     Board Version 12.x door, you need to use a /12 command line
  31.     parameter.  If you are running a PC Board Version 14.x door, you
  32.     need to use a /14 command line parameter.
  33.     
  34.        If a /12 or /14 is not included in the command line, SFPCBDR
  35.     will not run, but rather display the correct command usage and
  36.     return you to the DOS prompt.   
  37.     
  38.        SFPCBDR also uses a /P command line parameter to determine the 
  39.     drive and directory where the PC Board door program files exist 
  40.     and the placement of PCBOARD.DAT, PCBOARD.SYS and USERS file.  In 
  41.     other words, let's assume SPITFIRE is being run from the SF directory 
  42.     of drive C and a DOORA directory was created from the SF directory 
  43.     for the PC Board door program files.   Your command line would look 
  44.     like one of these listed below (depending on whether you are 
  45.     running a PC Board Version 12.x or a PC Board Version 14.x door):
  46.     
  47.     SFPCBDR /P C:\SF\DOOR1 /12
  48.     
  49.     SFPCBDR /P C:\SF\DOOR1 /14    
  50.     
  51.     If no /P command line parameter is set, SFPCBDR will not run, but
  52.     rather display the correct command usage and return you to the 
  53.     DOS prompt.
  54.        
  55.        When SFPCBDR is executed it first will check for the SFDOORS.DAT 
  56.     file.  If this is found, this signifies that the PC Board door 
  57.     program has been set up to run as a SPITFIRE door.  If this is not 
  58.     found, it continues to look for SFMAIN.DAT, SFMESS.DAT or SFFILE.DAT, 
  59.     in the order listed.  If one of these files are found it signifies 
  60.     the PC Board door program is being run as a Sysop configurable 
  61.     command from the corresponding menu.  This allows SFPCBDR to determine 
  62.     which batch file will be used to run the PC Board door program.  If 
  63.     none of the above mentioned DAT files are found SFPCBDR will not run.
  64.     
  65.        SFPCBDR will then read and obtain information from the SFSYSDAT.SYS,
  66.     SFDOORS.DAT, SFUSERS.DAT and DAILYLMT.DAT.  The information obtained 
  67.     from these files is used to create the PCBOARD.DAT, PCBOARD.SYS and
  68.     USERS files.  PCBOARD.DAT, PCBOARD.SYS and USERS are files used with 
  69.     PC Board door programs.  PCBOARD.DAT, PCBOARD.SYS and USERS are then 
  70.     written to the directory you specified earlier with the /P command 
  71.     line parameter.  
  72.     
  73.        It should also be mentioned that if SFPCBDR fails to run because
  74.     the /P command line parameter has not been specified or due to the
  75.     inability to locate the necessary DAT file, SFPCBDR will send an 
  76.     ERRORLEVEL 1 to DOS.  If DAILYLMT.DAT is not found, SFPCBDR will
  77.     default to 20 downloads per day and 1000K downloadable bytes per day.
  78.        
  79.     
  80.     USING SFPCBDR TO RUN A SPITFIRE DOOR
  81.     ------------------------------------
  82.        
  83.        The first thing you will need to be concerned with when using
  84.     SFPCBDR to run a SPITFIRE door will be to create or modify an existing
  85.     SFDOOR.MNU.  Using your favorite text editor you will need to
  86.     include a line that contains a brief description of the door program
  87.     you intend to run, a comma, and the security level required by the
  88.     user to access this SPITFIRE door.  (The line number should correspond 
  89.     to the door number you are running your door program in.  For this 
  90.     example we will be using Door_A.  For more detailed information 
  91.     refer to the SPITFIRE manual.)  A typical line of your SFDOOR.MNU might
  92.     look like this:
  93.     
  94.     The Door Description,10
  95.     
  96.     If you are using SFDR[x].BBS/CLR Sysop created non-Ansi and Ansi
  97.     menus these will need to be modified also.
  98.     
  99.        Next you will also need to modify your SF.BAT file with your 
  100.     favorite text editor.  Locate the line which contains :DOOR_A.
  101.     You will need to place your Door_A commands (valid DOS commands,
  102.     program execution, etc.) between :DOOR_A and GOTO LOOP.  A typical
  103.     example of this portion of your SF.BAT might be changed to read as
  104.     listed below:
  105.     
  106.       PC Board Version 12.x              PC Board Version 14.x 
  107.       ---------------------              ---------------------
  108.  
  109.       :DOOR_A                           :DOOR_A
  110.       SFPCBDR /P C:\SF\DOOR1 /12        SFPCBDR /P C:\SF\DOOR1 /14
  111.       IF ERRORLEVEL 1 GOTO LOOP         IF ERRORLEVEL 1 GOTO LOOP
  112.       CD\SF\DOOR1                       CD\SF\DOOR1
  113.       PROGRAM NAME                      PROGRAM NAME  
  114.       DEL PCBOARD.SYS                   DEL PCBOARD.SYS
  115.       DEL PCBOARD.DAT                   DEL PCBOARD.DAT
  116.       DEL USERS                         DEL USERS
  117.       CD\SF                             CD\SF
  118.       GOTO LOOP                         GOTO LOOP
  119.          
  120.     If the PC Board door program you are using requires the use of a 
  121.     configuration file, the name of the configuration file would be added 
  122.     on the same line as, and after the PROGRAM NAME.  For instance, instead 
  123.     of PROGRAM NAME you would need PROGRAM NAME and a blank space followed 
  124.     by the name of the configuration file.      
  125.      
  126.        You will also notice, after the program completes execution the
  127.    batch file is directed to erase the files created using SFPCBDR.  You
  128.    may eliminate this and simply have SFPCBDR overwrite the existing
  129.    files or erase them in the batch file (as the above example) to
  130.    conserve disk space.
  131.    
  132.        
  133.     USING SFPCBDR FROM A SPITFIRE MENU
  134.     ----------------------------------
  135.     
  136.        SPITFIRE has a Sysop configurable command for the Main, Message 
  137.     and File menus.  The Sysop configurable command is executed through 
  138.     a batch file which corresponds to the menu it is being run from.  In
  139.     other words, SFMAIN.BAT runs the Sysop configurable command from the
  140.     Main Menu, SFMESS.BAT runs the one from the Message Menu and SFFILE.BAT 
  141.     the one from the File Menu.  The commands necessary to execute SFPCBDR 
  142.     and run the PC Board door program are set up in the batch file which 
  143.     corresponds to the menu you wish to have program run from.
  144.  
  145.        The first thing you will need to establish is which of these menus
  146.     you wish to use to run the PC Board door program.  For 
  147.     this purpose, let's assume that it is going to be set up so it can be 
  148.     run from the Main Menu.  (It should be noted the set up procedure will 
  149.     be the same regardless of which Menu you are running SFPCBDR and the 
  150.     PC Board door program from.)
  151.  
  152.        Next, you will need to decide what you wish to name the command
  153.     option and establish what security level will be required for
  154.     users of your system to be able to access this option.  Once this
  155.     is determined you will need to modify the SFMAIN.MNU file using
  156.     your favorite text editor, as long as it saves in ASCII format.
  157.     (Refer to the SPITFIRE manual for further documentation on this
  158.     if needed.  It should also be noted that if SFPCBDR were being
  159.     set up to run from the File Menu, you would need to modify the
  160.     SFFILE.MNU file and if it was being set up to be run from the
  161.     Message Menu you would need to modify the SFMSG.MNU file.)
  162.  
  163.        Examining the default SFMAIN.MNU file, you will notice the Sysop
  164.     configurable command appears as:
  165.  
  166.        <K>............. Add Your Own,,1000,@
  167.  
  168.        This will need to be replaced with a Command Character that will
  169.     be used to select the option from the menu.  It is ASOLUTELY IMPERATIVE
  170.     that the Command Character must not duplicate an existing Command
  171.     Character for another menu option.  You will then need to include
  172.     a brief description of the PC Board door program you are running, 
  173.     two commas, the security level required to access this feature, and 
  174.     another comma followed by the a @.  The @ must not be changed! (For 
  175.     more detailed information on modifying your SFMAIN.MNU, SFMSG.MNU or 
  176.     SFFILE.MNU refer to your SPITFIRE manual.)
  177.     
  178.        <K>.... Brief Program Description,,10,@
  179.  
  180.        Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  181.     so that it can be executed from the Main Menu.  Do this using your
  182.     favorite text editor, as long as it saves in ASCII format.  (Again, it
  183.     should be noted that if SFPCBDR and the PC Board door program were 
  184.     being set up to run from the File Menu, you would need to modify 
  185.     the SFFILE.BAT file and if it was being set up to be run from the 
  186.     Message Menu you would need to modify the SFMESS.BAT file.)
  187.  
  188.        The commands you will need to include in your SFMAIN.BAT to run 
  189.     SFPCBDR and the PC Board (Version 12) door program might look 
  190.     similar to this:
  191.    
  192.        PC Board Version 12.x             PC Board Version 14.x
  193.        ---------------------             ---------------------
  194.    
  195.        ECHO OFF                          ECHO OFF                         
  196.        BRK OFF                           BRK OFF
  197.        SFPCBDR /P C:\SF\DIRNAME /12      SFPCBDR /P C:\SF\DIRNAME /14
  198.        IF ERRORLEVEL 1 GOTO END          IF ERRORLEVEL 1 GOTO END
  199.        CD\SF\DIRNAME                     CD\SF\DIRNAME
  200.        PROGRAM NAME                      PROGRAM NAME
  201.        :END                              :END
  202.        CD\SF                             CD\SF
  203.        BRK ON                            BRK ON
  204.  
  205.        (BRK is written and copyrighted by Solid Systems, 1985, but can 
  206.     be downloaded from Buffalo Creek's BBS as well as a number of other 
  207.     BBS systems.  BRK is not required, however, it is recommended since 
  208.     it will prevent a caller using the CTRL BRK command to terminate the 
  209.     batch file, gaining access to your system at the DOS level.)
  210.  
  211.       In the above example, C:\SF\DIRNAME refers to the drive and the 
  212.     directory in which the PC Board door program files reside.  The actual 
  213.     PC Board  door program name would be entered where PROGRAM NAME is 
  214.     currently.   If the PC Board door program you are using requires the 
  215.     use of a configuration file, the name of the configuration file would 
  216.     be added on the same line as and after the program name.  For instance, 
  217.     instead of PROGRAM NAME you would need PROGRAM NAME and a blank space 
  218.     followed by the name of the configuration file.      
  219.     
  220.     
  221.     SPECIAL NOTE
  222.     ------------
  223.     
  224.        Some PC Board door programs require the use of BRUN[x].EXE and
  225.     DORPCH[x].EXE files to run.  The individual door program documentation 
  226.     should provide specific information on this.  It has been discovered, 
  227.     however, DORPCH[x].EXE will not run on some systems.  If you experience
  228.     such difficulty, limit door conversion using SFPCBDR to PC Board door 
  229.     programs which do not require DORPCH[x].EXE and you should have no 
  230.     problems.
  231.     
  232.     
  233.     DISTRIBUTION
  234.     ------------
  235.  
  236.        SFPCBDR is distributed under the shareware concept.  You are free 
  237.     to distribute the SFPCBDR program as long as it remains unmodified and 
  238.     no fee is charged.  If you use this program and find it beneficial a 
  239.     fee is required.  A $1.00 fee is required of registered SPITFIRE Sysops 
  240.     and a $5.00 fee is required of all others.  
  241.     
  242.     
  243.     DISCLAIMER
  244.     ----------
  245.  
  246.        Mike Woltz and Buffalo Creek Software shall not be held responsible 
  247.     for any damage incurred by the user to hardware, software or peripheral 
  248.     devices while running SFPCBDR.  All responsibility lies with the user 
  249.     of the software.
  250.  
  251.  
  252.        The documentation for SFPCBDR is contributed by Jacque Shipley and 
  253.     The Mother Board BBS.  The shareware version of SPITFIRE and other 
  254.     SPITFIRE utilities are available for download from:
  255.  
  256.          Buffalo Creek's BBS              The Mother Board BBS
  257.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  258.            (515) 225-8496                    (515) 986-3464
  259.       19200/9600/2400/1200 Baud            9600/2400/1200 Baud
  260.